home *** CD-ROM | disk | FTP | other *** search
/ PD ROM 1 / PD ROM Volume I - Macintosh Software from BMUG (1988).iso / Programming / FORTH Folder / Conblk Folder / conblk.txt < prev   
Encoding:
Text File  |  1984-07-16  |  3.8 KB  |  86 lines  |  [TEXT/ttxt]
  1.  
  2.   Forth Block File Conversion for Transfer.
  3.  
  4. This text file describes a system for preparing MacForth Blocks
  5. files for transfer to systems such as CIS, and reconverting the
  6. files to Blocks files after transfer from other systems.  A Forth
  7. blocks file is a continuous stream of text characters, not delimited
  8. by carriage returns or other separaters.  Each Forth block occupies
  9. 1024 bytes of the file, starting on at (1024 * block number).  Likewise,
  10. each line occupies 64 bytes.
  11.  
  12. This format is inconvenient for transfer to line-oriented systems.
  13. The program "Convert" is a MacFORTH program to convert such block
  14. files to a line-oriented form.  The format of such a converted file is:
  15.  
  16.   1.  Each screen is introduced by a line of the form
  17.       ~Sn
  18. where n is the screen number in as many digits as required.
  19.  
  20.   2.  Each line starts with the three character  ~nn  , where nn is two
  21. digits, and is the line number (0<=nn<=15).  Rarely, a Forth block will
  22. contain one or more characters not in the ASCII printable range
  23. (space thru tilde, $20 thru $7E).  Any line containing such characters
  24. is represented in the form of hex pairs.  Such lines begin with
  25.       ~Hnn    or   ~-nn
  26. where the first 32 characters of the line are in the line starting with
  27. ~Hnn, and the remainder are in the line starting with ~-nn.
  28.  
  29.      Trailing blanks are not included in either normal or hex lines.  If a
  30. hex line is left with fewer than 33 characters after discarding trailing
  31. blanks, the ~-nn line is not included.  An all-blank line is not represented
  32. in the text file at all.
  33.    
  34.   3.  Each screen continues until the header for the next.  The last screen
  35. terminates at an end sentinal line,
  36.       ~E0000
  37.  
  38.   4.  The conversion from Block to Text produces the file described
  39. above, with each screen represented, even if blank, and the screens in
  40. order (and the lines in order within each screen).  The requirements of
  41. the conversion from Text to Block are more relaxed, in that:
  42.     a.  Lines before the first ~Sn line and after the ~E0000 line are
  43. ignored.
  44.     b.  Screens may appear in any order, as may lines within a screen.
  45.     c.  Screens not appearing in the text file are set to all blanks.
  46.  
  47. Getting started:
  48.   The MicroSoft BASIC program TOBLKS.BAS is provided to solve the 
  49. problem of acquiring the Convert Forth program.  Download TOBLKS.BAS.
  50. Download CONBLK.4TH, which is the Forth program.  Use TOBLKS.BAS to
  51. convert CONBLK.4TH into the block file Convert.  You will need 50K 
  52. free on your BASIC disk at the start of this process.  Copy Convert to
  53. your Forth disk.
  54.  
  55. Usage:
  56.   The best way to operate the Convert package is to launch the program
  57. from Finder by double-clicking the Convert icon.  Use the Convert menu
  58. (the corresponding words are hidden in a vocabulary called
  59. File.Conversion).  Follow the prompts.  Return to Finder when finished,
  60. or execute FORGET File.Conversion to remove the package from 
  61. MacFORTH.  (To see each text line read from or written to the text file,
  62. turn on the Debug item in the Options menu.)
  63.  
  64. Notice:
  65.   The version of Convert currently available is preliminary.  It is not
  66. robust when errors are encountered.  Comments and criticisms will be
  67. welcomed.  Although there is little checking for communication errors,
  68. the requirement that text file lines being with ~ and specific following
  69. characters will at least catch failures in which the beginnings of lines
  70. are dropped.
  71.  
  72.   I desire to improve this program.  In particular, I would like to 
  73. provide for checksumming, probably at the screen level, with the
  74. checksum in hex following the n in ~Sn.  Advice would be appreciated,
  75. particulary as to a good checksum algorithm which is position
  76. dependent, so that dropped or increased white space is detected.
  77.  
  78. Contact:  John W. Baxter
  79.                750 State Street
  80.                San Diego, CA 92101
  81. 619-232-4240
  82. CIS 71735,1626
  83. MCI Mail JBaxter (the one in San Diego).
  84.  
  85.  
  86. Press ENTER to continue: